Package com.cisco.pt.ipc.sim.impl
Class NFExporterImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.ProcessImpl
com.cisco.pt.ipc.sim.impl.NFExporterImpl
- All Implemented Interfaces:
IPCObject,NFExporter,Process
Information provided by the PKI file:
\class NFExporter
\brief NFExporter handles and manipulates NetFlow exporters.
\example network().getDevice("Router0").getNetflowExporterManager().getNFExporterAt(0)
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionNFExporterImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionvoidaddMonitor(String monitorName) Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:longInformation provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:getTemplateById(int id) Information provided by the PKI file:getTemplateByRecordName(String recordName) Information provided by the PKI file:booleanInformation provided by the PKI file:voidremoveMontior(String monitorName) Information provided by the PKI file:booleanremoveTemplate(int templateId) Information provided by the PKI file:voidsetDestinationAddr(IPAddress ip_add) Information provided by the PKI file:voidsetDestinationUdpPort(int port) Information provided by the PKI file:voidsetExporterName(String name) Information provided by the PKI file:voidsetExporterVersion(int version) Information provided by the PKI file:voidsetSrcPort(String port) Information provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.sim.impl.ProcessImpl
getOwnerDeviceMethods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSessionMethods inherited from interface com.cisco.pt.ipc.sim.Process
getOwnerDevice
-
Constructor Details
-
NFExporterImpl
public NFExporterImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
getTemplateById
Information provided by the PKI file:
\brief Returns the NetFlow template with the specified ID. \param id, the ID of the NetFlow template of interest. \return NFTemplate, the NFTemplate object with the specified ID.- Specified by:
getTemplateByIdin interfaceNFExporter- Parameters:
id- Takes in a parameter of id- Returns:
- NFTemplate Returns a NFTemplate
-
getTemplateByRecordName
Information provided by the PKI file:
\brief Returns the NetFlow template with the specified record name. \param recordName, the record name of the NetFlow template of interest. \return NFTemplate, the NFTemplate object with the specified record name.- Specified by:
getTemplateByRecordNamein interfaceNFExporter- Parameters:
recordName- Takes in a parameter of recordName- Returns:
- NFTemplate Returns a NFTemplate
-
removeTemplate
public boolean removeTemplate(int templateId) Information provided by the PKI file:
\brief Removes the NetFlow template with the specified ID. \param templateId, the ID of the NetFlow template of interest. \return bool, true if successful, otherwise false.- Specified by:
removeTemplatein interfaceNFExporter- Parameters:
templateId- Takes in a parameter of templateId- Returns:
- boolean Returns a boolean
-
setExporterName
Information provided by the PKI file:
\brief Sets the name for the NetFlow exporter. \param name, the name for the NetFlow exporter.- Specified by:
setExporterNamein interfaceNFExporter- Parameters:
name- Takes in a parameter of name
-
getExporterName
Information provided by the PKI file:
\brief Returns the name of the NetFlow exporter. \return string, the name of the NetFlow exporter.- Specified by:
getExporterNamein interfaceNFExporter- Returns:
- String Returns a String
-
setExporterVersion
public void setExporterVersion(int version) Information provided by the PKI file:
\brief Sets the version for the NetFlow exporter. \param version, the version for the NetFlow exporter.- Specified by:
setExporterVersionin interfaceNFExporter- Parameters:
version- Takes in a parameter of version
-
getExporterVersion
public int getExporterVersion()Information provided by the PKI file:
\brief Returns the version of the NetFlow exporter. \return int, the version of the NetFlow exporter.- Specified by:
getExporterVersionin interfaceNFExporter- Returns:
- int Returns a int
-
getDeviceUpTime
public long getDeviceUpTime()Information provided by the PKI file:
\brief Returns the device up time. \return int, the device up time.- Specified by:
getDeviceUpTimein interfaceNFExporter- Returns:
- long Returns a long
-
isFullyConfigured
public boolean isFullyConfigured()Information provided by the PKI file:
\brief Returns true if the NetFlow exporter is fully configured, otherwise false. \return bool, true if the NetFlow exporter is fully configured, otherwise false.- Specified by:
isFullyConfiguredin interfaceNFExporter- Returns:
- boolean Returns a boolean
-
setSrcPort
Information provided by the PKI file:
\brief Sets the source port. \param port, portName can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0- Specified by:
setSrcPortin interfaceNFExporter- Parameters:
port- Takes in a parameter of port
-
getSrcPort
Information provided by the PKI file:
\brief Returns the source port. \return Port, the Port object of the source port.- Specified by:
getSrcPortin interfaceNFExporter- Returns:
- Port Returns a Port
-
setDestinationAddr
Information provided by the PKI file:
\brief Sets the destination IP address. \param ip_add, the IP address of the destination.- Specified by:
setDestinationAddrin interfaceNFExporter- Parameters:
ip_add- Takes in a parameter of ip_add
-
getDestinationAddr
Information provided by the PKI file:
\brief Returns the destination IP address. \return ip, the IP address of the destination.- Specified by:
getDestinationAddrin interfaceNFExporter- Returns:
- IPAddress Returns a IPAddress
-
setDestinationUdpPort
public void setDestinationUdpPort(int port) Information provided by the PKI file:
\brief Sets the destination UDP port number. \param port, the UDP port number for the destination.- Specified by:
setDestinationUdpPortin interfaceNFExporter- Parameters:
port- Takes in a parameter of port
-
getDestinationUdpPort
public int getDestinationUdpPort()Information provided by the PKI file:
\brief Returns the destination UDP port number. \return int, the UDP port number of the destination.- Specified by:
getDestinationUdpPortin interfaceNFExporter- Returns:
- int Returns a int
-
addMonitor
Information provided by the PKI file:
\brief Adds a monitor with the specified name. \param monitorName, the name for the monitor.- Specified by:
addMonitorin interfaceNFExporter- Parameters:
monitorName- Takes in a parameter of monitorName
-
removeMontior
Information provided by the PKI file:
\brief Removes the monitor with the specified name. \param monitorName, the name of the monitor of interest.- Specified by:
removeMontiorin interfaceNFExporter- Parameters:
monitorName- Takes in a parameter of monitorName
-
createFrameInstance
Information provided by the PKI file:
\brief Creates a frame instance. \return FrameInstance, the FrameInstance object of the frame instance.- Specified by:
createFrameInstancein interfaceNFExporter- Returns:
- FrameInstance Returns a FrameInstance
-